﻿<!DOCTYPE html>
<html lang="en">
<head>
    <link rel="stylesheet" href="../../Styles/jqx.apireference.css" type="text/css" />
    <script type="text/javascript" src="../../scripts/jquery-1.11.1.min.js"></script>
    <script type="text/javascript" src="../../scripts/documentation.js"></script>
    <meta name="keywords" content="jQuery, jqxLoader Help Documentation" />
    <title>jqxLoader API Documentation</title>
    <script type="text/javascript">
        $(document).ready(function () {
            $(".documentation-option-type-click").click(function (event) {
                $(event.target).parents('tr').next().find(".property-content").toggle();
            });
        });
    </script>
</head>
<body>
     <div id="properties">
            <h2 class="documentation-top-header">Properties</h2>
            <table class="documentation-table">
                <tr>
                    <th>Name
                    </th>
                    <th>Type
                    </th>
                    <th>Default
                    </th>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span7'>autoOpen</span>
                    </td>
                    <td>
                        <span>Boolean</span>
                    </td>
                    <td>false
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets whether the loader will be shown after it's creation.
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Set the <code>autoOpen</code> property.
                            </p>
                            <pre><code>$('#jqxLoader').jqxLoader({ autoOpen: true }); </code></pre>
                            <p>
                                Get the <code>autoOpen</code> property.
                            </p>
                            <pre><code>var autoOpen = $('#jqxLoader').jqxLoader('autoOpen'); </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-autoopen-property">autoOpen is set to true</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span2'>height</span>
                    </td>
                    <td>
                        <span>Number/String</span>
                    </td>
                    <td>150
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets the loader's height.
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Set the <code>height</code> property.
                            </p>
                            <pre><code>$("#jqxLoader").jqxLoader({ height: 150 });</code></pre>
                            <p>
                                Get the <code>height</code> property.
                            </p>
                            <pre><code>var height = $('#jqxLoader').jqxLoader('height');</code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-height-property">height is set to 150</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span3'>html</span>
                    </td>
                    <td>
                        <span>String</span>
                    </td>
                    <td>null
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets the loader's content.
                            </p>
                            <h4>Code example</h4>
                            <p>
                                Set the <code>html</code> property.
                            </p>
                            <pre><code>$("#jqxLoader").jqxLoader({html: "Next Loading" });</code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-html-property">html is set to a custom HTML string.</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span39'>isModal</span>
                    </td>
                    <td>
                        <span>Boolean</span>
                    </td>
                    <td>false
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets whether the loader is displayed as a modal dialog.
                                                                                    If the jqxLoader's mode is set to modal, the loader blocks user interaction with the underlying user interface.
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Set the <code>isModal</code> property.
                            </p>
                            <pre><code>$('#jqxLoader').jqxLoader({ isModal: true }); </code></pre>
                            <p>
                                Get the <code>isModal</code> property:
                            </p>
                            <pre><code>var isModal = $('#jqxLoader').jqxLoader('isModal'); </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-ismodal-property">isModal is set to true</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span4'>imagePosition</span>
                    </td>
                    <td>
                        <span>String</span>
                    </td>
                    <td>'center'
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets the image's position. Possible values: 'top', 'bottom' and 'center'
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Set the <code>imagePosition</code> property.
                            </p>
                            <pre><code>$('#jqxLoader').jqxLoader({ imagePosition: 'center' }); </code></pre>
                            <p>
                                Get the <code>imagePosition</code> property:
                            </p>
                            <pre><code>var imagePosition = $('#jqxLoader').jqxLoader('imagePosition'); </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-imageposition-property">imagePosition is set to 'top'</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span14'>rtl</span>
                    </td>
                    <td>
                        <span>Boolean</span>
                    </td>
                    <td>false
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets a value indicating whether widget's text is aligned to support
                                                                                    locales using right-to-left fonts.
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Set the <code>rtl</code> property.
                            </p>
                            <pre><code>$("#jqxLoader").jqxLoader({ rtl: false});</code></pre>
                            <p>
                                Get the <code>rtl</code> property.
                            </p>
                            <pre><code>var rtl = $('#jqxLoader').jqxLoader('rtl');</code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-rtl-property">rtl is set to true</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span8'>text</span>
                    </td>
                    <td>
                        <span>String</span>
                    </td>
                    <td>"Loading..."
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets the loader's text.
                            </p>
                            <h4>Code example</h4>
                            <p>
                                Set the <code>text</code> property.
                            </p>
                            <pre><code>$("#jqxLoader").jqxLoader({text: "This is a loader..." });</code></pre>
                            <p>
                                Get the <code>text</code> property.
                            </p>
                            <pre><code>var text = $('#jqxLoader').jqxLoader('text'); </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-text-property">text is set to 'Loading jQWidgets files'.</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span17'>textPosition</span>
                    </td>
                    <td>
                        <span>String</span>
                    </td>
                    <td>"bottom"
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets the alignment.
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Set the <code>textPosition</code> property.
                            </p>
                            <pre><code>$("#jqxLoader").jqxLoader({ textPosition: "left" });</code></pre>
                            <p>
                                Get the <code>textPosition</code> property.
                            </p>
                            <pre><code>var textPosition = $('#jqxLoader').jqxLoader('textPosition'); </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-textposition-property">textPosition is set to 'left'</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span63'>theme</span>
                    </td>
                    <td>
                        <span>String</span>
                    </td>
                    <td>''
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets the widget's theme.
                            </p>
                            jQWidgets uses a pair of css files - jqx.base.css and jqx.[theme name].css. The
                                                                                base stylesheet creates the styles related to the widget's layout like margin, padding,
                                                                                border-width, position. The second css file applies the widget's colors and backgrounds.
                                                                                The jqx.base.css should be included before the second CSS file. In order to set
                                                                                a theme, you need to do the following:
                                                                                <ul>
                                                                                    <li>Include the theme's CSS file after jqx.base.css.<br />
                                                                                        The following code example adds the 'energyblue' theme.
                                                                                        <pre><code>
                                                                                        <pre><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;../../jqwidgets/styles/jqx.base.css&quot; type=&quot;text/css&quot; /&gt;
&lt;link rel=&quot;stylesheet&quot; href=&quot;../../jqwidgets/styles/jqx.energyblue.css&quot; type=&quot;text/css&quot; /&gt;</code></pre>
                                </code></pre>
                                                                                    </li>
                                                                                    <li>Set the widget's theme property to 'energyblue' when you initialize it. </li>
                                                                                </ul>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-theme-property">theme
                                                                                        is set to 'energyblue'
                                </a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span1'>width</span>
                    </td>
                    <td>
                        <span>Number/String</span>
                    </td>
                    <td>150
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                Sets or gets the jqxLoader's width.
                            </p>
                            <h4>Code example</h4>
                            <p>
                                Set the <code>width</code> property.
                            </p>
                            <pre><code>$('#jqxLoader').jqxLoader({ width: '150px' });</code></pre>
                            <p>
                                Get the <code>width</code> property.
                            </p>
                            <pre><code>var width = $('#jqxLoader').jqxLoader('width');</code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-width-property">width is set to 200</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <h2 class="documentation-top-header">Events</h2>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span27'>create</span>
                    </td>
                    <td>
                        <span>Event</span>
                    </td>
                    <td></td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>
                                This event is triggered when the user creates loader for the first time.
                            </p>
                            <h4>Code examples</h4>
                            <p>
                                Bind to the <code>create</code> event by type: jqxLoader.
                            </p>
                            <pre><code>$('#jqxLoader').on('create', function () { // Some code here. }); </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-create-event">Bind to the create event by type: jqxLoader.</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <h2 class="documentation-top-header">Methods</h2>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span26'>close</span>
                    </td>
                    <td>
                        <span>Method</span>
                    </td>
                    <td></td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>Closing the current loader.</p>
                                 <div class="methodArgs">
                                <table class="arguments">
                                    <tbody>
                                        <tr>
                                            <th>Parameter</th>
                                            <th>Type</th>
                                            <th>Description</th>
                                        </tr>
                                        <tr>
                                            <td><em>None</em></td>
                                            <td></td>
                                            <td></td>
                                        </tr>                                  
                                    </tbody>
                                </table>
                                <strong>Return Value</strong><br /> 
                                <em>None</em>
                            </div>
                            <h4>Code example</h4>
                            <p>
                                Invoke the <code>close</code> method.
                            </p>
                            <pre><code>$('#jqxLoader').jqxLoader('close');
                        </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-close-method">closes the jqxLoader.</a>
                            </div>
                        </div>
                    </td>
                </tr>
                <tr>
                    <td class="documentation-option-type-click">
                        <span id='Span28'>open</span>
                    </td>
                    <td>
                        <span>Method</span>
                    </td>
                    <td></td>
                </tr>
                <tr>
                    <td colspan='3' style='width: 100%'>
                        <div class="documentation-option-description property-content" style="display: none;">
                            <p>Opening/showing the current loader. You can optionally call the method with <code>left</code> and <code>top</code> arguments</p>
                                <div class="methodArgs">
                                <table class="arguments">
                                    <tbody>
                                        <tr>
                                            <th>Parameter</th>
                                            <th>Type</th>
                                            <th>Description</th>
                                        </tr>
                                        <tr>
                                            <td><em>None</em></td>
                                            <td></td>
                                            <td></td>
                                        </tr>                                  
                                    </tbody>
                                </table>
                                <strong>Return Value</strong><br /> 
                                <em>None</em>
                            </div>
                            <h4>Code example</h4>
                            <p>
                                Invoke the <code>open</code> method.
                            </p>
                            <pre><code>$('#jqxLoader').jqxLoader('open');
                        </code></pre>
                            <div style="padding-bottom: 5px;">
                                <em>Try it:</em> <a target="_blank" href="https://www.jqwidgets.com/jseditor/?key=jqxloader-open-method">opens the jqxLoader.</a>
                            </div>
                        </div>
                    </td>
                </tr>
            </table>
            <br />
        </div>
</body>
</html>
